---
layout: m1x_soap
title: Downloadable Link List
---

<h3><a name="product_downloadable_link.list-Module%3AComplexProductAPI"></a>Module: Complex Product API</h3>


<h4><a name="product_downloadable_link.list-Resource%3Aproductdownloadablelink"></a>Resource: product_downloadable_link</h4>


<h5><a name="product_downloadable_link.list-Method%3A"></a>Method:</h5>

<ul>
	<li>product_downloadable_link.list (SOAP V1)</li>
	<li>catalogProductDownloadableLinkList (SOAP V2)</li>
</ul>


<p>Allows you to retrieve a list of links of a downloadable product.</p>

<p><b>Arguments</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sessionId </td>
<td> Session ID </td>
</tr>
<tr>
<td> string </td>
<td> productId </td>
<td> Product ID or SKU </td>
</tr>
<tr>
<td> string </td>
<td> store </td>
<td> Store view ID or code (optional) </td>
</tr>
<tr>
<td> string </td>
<td> identifierType </td>
<td> Defines whether the product ID or SKU is passed in the request </td>
</tr>
</tbody></table>


<p><b>Return:</b></p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> array </td>
<td> result </td>
<td> Array of catalogProductDownloadableLinkListEntity </td>
</tr>
</tbody></table>


<p>The <b>catalogProductDownloadableLinkListEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> array </td>
<td> links </td>
<td> Array of catalogProductDownloadableLinkEntity </td>
</tr>
<tr>
<td> array </td>
<td> samples </td>
<td> Array of catalogProductDownloadableLinkSampleEntity </td>
</tr>
</tbody></table>


<p>The <b>catalogProductDownloadableLinkEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> link_id <br class="atl-forced-newline" /> </td>
<td> Link ID </td>
</tr>
<tr>
<td> string </td>
<td> title <br class="atl-forced-newline" /> </td>
<td> Link title </td>
</tr>
<tr>
<td> string </td>
<td> price <br class="atl-forced-newline" /> </td>
<td> Downloadable link price value&nbsp; <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> number_of_downloads <br class="atl-forced-newline" /> </td>
<td> Maximum number of possible downloads </td>
</tr>
<tr>
<td> int </td>
<td> is_unlimited <br class="atl-forced-newline" /> </td>
<td> Defines whether the number of downloads is unlimited </td>
</tr>
<tr>
<td> int </td>
<td> is_shareable <br class="atl-forced-newline" /> </td>
<td> Defines whether the link is shareable </td>
</tr>
<tr>
<td> string </td>
<td> link_url <br class="atl-forced-newline" /> </td>
<td> Link URL address </td>
</tr>
<tr>
<td> string </td>
<td> link_type <br class="atl-forced-newline" /> </td>
<td> Type of the link data source. Can have one of the following values: "file" or "url" <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string </td>
<td> sample_file <br class="atl-forced-newline" /> </td>
<td> Sample file name </td>
</tr>
<tr>
<td> string </td>
<td> sample_url <br class="atl-forced-newline" /> </td>
<td> Sample URL </td>
</tr>
<tr>
<td> string </td>
<td> sample_type <br class="atl-forced-newline" /> </td>
<td> Type of sample data source. Can have one of the following values: "file" or "url" <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> int </td>
<td> sort_order <br class="atl-forced-newline" /> </td>
<td> Link sort order </td>
</tr>
<tr>
<td> array </td>
<td> file_save <br class="atl-forced-newline" /> </td>
<td> Array of catalogProductDownloadableLinkFileInfoEntity </td>
</tr>
<tr>
<td> array </td>
<td> sample_file_save <br class="atl-forced-newline" /> </td>
<td> Array of catalogProductDownloadableLinkFileInfoEntity </td>
</tr>
</tbody></table>


<p>The <b>catalogProductDownloadableLinkSampleEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sample_id <br class="atl-forced-newline" /> </td>
<td> Sample ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> product_id <br class="atl-forced-newline" /> </td>
<td> Product ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> sample_file <br class="atl-forced-newline" /> </td>
<td> Sample file name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> sample_url <br class="atl-forced-newline" /> </td>
<td> Sample URL </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> sample_type <br class="atl-forced-newline" /> </td>
<td> Sample type. Can have one of the following values: "file" or "url" </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> sort_order <br class="atl-forced-newline" /> </td>
<td> Sort order </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> default_title <br class="atl-forced-newline" /> </td>
<td> Default title </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_title <br class="atl-forced-newline" /> </td>
<td> Store title </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> title <br class="atl-forced-newline" /> </td>
<td> Sample title </td>
</tr>
</tbody></table>


<p>The <b>catalogProductDownloadableLinkFileInfoEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> file <br class="atl-forced-newline" /> </td>
<td> File </td>
</tr>
<tr>
<td> string </td>
<td> name <br class="atl-forced-newline" /> </td>
<td> File name </td>
</tr>
<tr>
<td> int </td>
<td> size <br class="atl-forced-newline" /> </td>
<td> File size </td>
</tr>
<tr>
<td> string </td>
<td> status <br class="atl-forced-newline" /> </td>
<td> Status </td>
</tr>
</tbody></table>



<p><b>Faults:</b><br/>
<em>No Faults</em></p>

<h4><a name="product_downloadable_link.list-Examples"></a>Examples</h4>

<h5><a name="product_downloadable_link.list-RequestExampleSOAPV1"></a>Request Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy-&gt;login('apiUser', 'apiKey');

$downloadableProductId = '5';

$resultList = $proxy-&gt;call(
    $sessionId,
    'product_downloadable_link.list',
    array($downloadableProductId)
);</pre>
		</div>
</div></div>


<h5><a name="product_downloadable_link.list-RequestExampleSOAPV2"></a>Request Example SOAP V2</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy-&gt;login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy-&gt;catalogProductDownloadableLinkList($sessionId, '5', null, 'sku');
var_dump($result);</pre>
		</div>
</div></div>


<h5><a name="product_downloadable_link.list-RequestExampleSOAPV2%28WSIComplianceMode%29"></a>Request Example SOAP V2 (WS-I Compliance Mode)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');

$sessionId = $proxy-&gt;login((object)array('username' =&gt; 'apiUser', 'apiKey' =&gt; 'apiKey'));

$result = $proxy-&gt;catalogProductDownloadableLinkList((object)array('sessionId' =&gt; $sessionId-&gt;result, 'productId' =&gt; '5'));

var_dump($result-&gt;result);</pre>
		</div>
</div></div>



<h5><a name="product_downloadable_link.list-ResponseExampleSOAPV1"></a>Response Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">array
  'links' =&gt;
    array
      0 =&gt;
        array
          'link_id' =&gt; string '1' (length=1)
          'title' =&gt; string 'link 1' (length=11)
          'price' =&gt; string '30.0000' (length=7)
          'number_of_downloads' =&gt; string '0' (length=1)
          'is_shareable' =&gt; string '1' (length=1)
          'link_url' =&gt; null
          'link_type' =&gt; string 'file' (length=4)
          'sample_file' =&gt; string '/s/o/software.jpg' (length=17)
          'sample_url' =&gt; null
          'sample_type' =&gt; string 'file' (length=4)
          'sort_order' =&gt; string '1' (length=1)
          'file_save' =&gt;
            array
              ...
          'sample_file_save' =&gt;
            array
              ...
          'is_unlimited' =&gt; int 1
  'samples' =&gt;
    array
      0 =&gt;
        array
          'sample_id' =&gt; string '1' (length=1)
          'product_id' =&gt; string '5' (length=1)
          'sample_url' =&gt; null
          'sample_file' =&gt; string '/s/o/software.jpg' (length=17)
          'sample_type' =&gt; string 'file' (length=4)
          'sort_order' =&gt; string '2' (length=1)
          'default_title' =&gt; string 'Sample 1' (length=8)
          'store_title' =&gt; string 'Sample 1' (length=8)
          'title' =&gt; string 'Sample 1' (length=8)</pre>
		</div>
</div></div>

				    

